serialio
Class Serial

java.lang.Object
  serialio.Serial

public class Serial
extends java.lang.Object

Serielle Ein-/Ausgabe.
Ein Objekt der Klasse Serial kapselt eine serielle Schnittstelle und damit einen seriellen Port. Festlegung der Übertragungs-Parameter kann nur bei der Objekt-Erzeugung vorgenommen werden.

Wenn alles gutgegangen ist, ist das Serial-Objekt danach bereit. Dies kann durch den Rückgabewert der Methode open() festgestellt werden (true bei bereit).

Das Serial-Objekt gestattet im Zustand "bereit" das Lesen bzw. Schreiben von einzelnen Bytes, Byte-Arrays oder Strings von der bzw. auf die seriellen Schnittstelle.

Installation

Die Java-COMM-Extensions, also das Paket javax.comm, gehört nicht zum JDK/JRE-Standard-Umfang und erfordert also die Installation im JDK oder JRE als installed extensions.

Copyright 2006, Michael Zimmer

See Also:

javax.comm.SerialPort

Field Summary

static int	DATABITS_5
static int	DATABITS_6
static int	DATABITS_7
static int	DATABITS_8
static int	PARITY_EVEN
static int	PARITY_NONE
static int	PARITY_ODD
static int	STOPBITS_1
static int	STOPBITS_1_5
static int	STOPBITS_2

Constructor Summary

Serial(java.lang.String portName, int baudrate, int dataBits, int stopBits, int parity)
Konstruktor.

Method Summary

void	close() Schließt die serielle Schnittstelle.
int	dataAvailable() Prüfen, ob Daten verfügbar sind.
boolean	isCTS() Status des Modem-Meldeeingangs CTS (clear to send).
boolean	isDSR() Status des Modem-Meldeeingangs DSR (data set ready).
boolean	open() Öffnet die serielle Schnittstelle.
int	read() Lesen eines Zeichens vom COM-Port.
int	read(byte[] b, int len) Lesen von Bytes vom COM-Port.
java.lang.String	readLine() Lesen eines Strings vom COM-Port.
void	setDTR(boolean arg) Setzen des Modem-Steuerausgangs DTR (data terminal ready).
void	setRTS(boolean arg) Setzen des Modem-Steuerausgangs RTS (request to send).
void	write(byte[] b, int len) Schreiben von Bytes auf den COM-Port.
void	write(int b) Schreiben eines Zeichens auf den COM-Port.
void	write(java.lang.String s) Schreiben eines String auf den COM-Port.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DATABITS_5

public static final int DATABITS_5

See Also:

Constant Field Values

DATABITS_6

public static final int DATABITS_6

See Also:

Constant Field Values

DATABITS_7

public static final int DATABITS_7

See Also:

Constant Field Values

DATABITS_8

public static final int DATABITS_8

See Also:

Constant Field Values

STOPBITS_1

public static final int STOPBITS_1

See Also:

Constant Field Values

STOPBITS_2

public static final int STOPBITS_2

See Also:

Constant Field Values

STOPBITS_1_5

public static final int STOPBITS_1_5

See Also:

Constant Field Values

PARITY_NONE

public static final int PARITY_NONE

See Also:

Constant Field Values

PARITY_ODD

public static final int PARITY_ODD

See Also:

Constant Field Values

PARITY_EVEN

public static final int PARITY_EVEN

See Also:

Constant Field Values

Constructor Detail

Serial

public Serial(java.lang.String portName,
              int baudrate,
              int dataBits,
              int stopBits,
              int parity)
       throws java.lang.Exception

Konstruktor.

Initialisiert die serielle Schnittstelle ohne sie zu öffnen.

Parameters:

portName - Der Name des Ports, z.B. COM1, COM2

baud - Baudrate

dataBits - Anzahl der Datenbits

parity - Parität

stopBits - Anzahl der Stopbits

Throws:

java.lang.Exception

Method Detail

open

public boolean open()
             throws java.lang.Exception

Öffnet die serielle Schnittstelle.

Ging alles gut, ist das Serial-Objekt verwendbar.

Returns:

true, wenn das Serial-Objekt verwendbar ist

Throws:

java.lang.Exception

close

public void close()
           throws java.io.IOException

Schließt die serielle Schnittstelle.
Nach dem Schließen der seriellen Schnittstelle ist das Serial-Objekt nicht mehr verwendbar.

Throws:

java.io.IOException

dataAvailable

public int dataAvailable()
                  throws java.io.IOException

Prüfen, ob Daten verfügbar sind.

Liefert die Anzahl der Bytes, die von der Schnittstelle gelesen werden können, ohne beim nächsten Aufruf von read() zu blockieren.

Returns:

Anzahl der verfügbaren Bytes

Throws:

java.io.IOException

read

public int read()
         throws java.io.IOException

Lesen eines Zeichens vom COM-Port.

Bei nicht bereiter Schnittstelle liefert sie -1.

Returns:

Das gelesene Byte (0..255) oder -1

Throws:

java.io.IOException

read

public int read(byte[] b,
                int len)
         throws java.io.IOException

Lesen von Bytes vom COM-Port.

Diese Methode liest mehrere Byteys vom Port. Bei nicht bereiter Schnittstelle liefert sie -1.

Parameters:

b - Der Buffer

len - Max. Anzahl der zu lesenden Bytes

Returns:

Die Anzahl der gelesenen Bytes oder -1

Throws:

java.io.IOException

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Lesen eines Strings vom COM-Port.

Die Methode liest eine Zeile, die durch ein Zeilenendezeichen ('\n' linefeed) abgeschlossen sein muss. Der zurückgegebene String enthält die Zeile ohne Zeilenendezeichen. Bei nicht bereiter Schnittstelle liefert sie null.

Returns:

Der String oder null

Throws:

java.io.IOException

write

public void write(int b)
           throws java.io.IOException

Schreiben eines Zeichens auf den COM-Port.

Diese Methode schreibt ein Byte auf den Port. Falls das Serial-Objekt nicht bereit ist, geschieht nichts.

Parameters:

b - Das zu schreibende Byte (0..255)

Throws:

java.io.IOException

write

public void write(byte[] b,
                  int len)
           throws java.io.IOException

Schreiben von Bytes auf den COM-Port.

Diese Methode schreibt mehrere Bytes auf den Port. Falls das Serial-Objekt nicht bereit ist, geschieht nichts.

Parameters:

b - Der Buffer

len - Max. Anzahl der zu schreibenden Bytes

Throws:

java.io.IOException

write

public void write(java.lang.String s)
           throws java.io.IOException

Schreiben eines String auf den COM-Port.

Diese Methode schreibt einen String auf den Port. Falls das Serial-Objekt nicht bereit ist, geschieht nichts.

Parameters:

s - Der String

Throws:

java.io.IOException

setRTS

public void setRTS(boolean arg)

Setzen des Modem-Steuerausgangs RTS (request to send).

Parameters:

arg - true, um RTS zu setzen

setDTR

public void setDTR(boolean arg)

Setzen des Modem-Steuerausgangs DTR (data terminal ready).

Parameters:

arg - true, um DTR zu setzen

isCTS

public boolean isCTS()

Status des Modem-Meldeeingangs CTS (clear to send).

Returns:

true, wenn DSR gesetzt ist

isDSR

public boolean isDSR()

Status des Modem-Meldeeingangs DSR (data set ready).

Returns:

true, wenn DSR gestezt ist